docs: fix broken anchors and missing word in README#2744
Open
sjhddh wants to merge 1 commit intogoogle:mainfrom
Open
docs: fix broken anchors and missing word in README#2744sjhddh wants to merge 1 commit intogoogle:mainfrom
sjhddh wants to merge 1 commit intogoogle:mainfrom
Conversation
- Container Scanning section: add missing "in" so the sentence reads "detect vulnerabilities in the following operating system packages..." - Guided remediation table: the "in-place" link pointed to anchor #in-place-lockfile-remediation, which does not exist on the docs page; the actual section anchor is #in-place-lockfile-changes. - Guided remediation table: the "relock" link reused the same broken anchor; it should point to #relock-and-relax-direct-dependencies, which is the section that actually documents that strategy. Verified anchor IDs against https://google.github.io/osv-scanner/experimental/guided-remediation/.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
Three small README fixes — all objectively wrong things, no judgment calls:
in-placelink points to#in-place-lockfile-remediation, which does not exist on the docs page. The actual H3 anchor is#in-place-lockfile-changes.relocklink reuses the same broken#in-place-lockfile-remediationanchor. The relock strategy lives at#relock-and-relax-direct-dependencies(also confirmed by inspecting the rendered docs page).Details
Verified each anchor by fetching https://google.github.io/osv-scanner/experimental/guided-remediation/ and listing the heading IDs. Only README.md is touched — six lines, three real fixes.
Testing
#in-place-lockfile-changes,#relock-and-relax-direct-dependencies,#override-dependency-versions) resolve to the correct sections on the live docs site.Checklist
docs:prefix).